﻿/* 
 * PROJECT: NyARToolkit(Extension)
 * --------------------------------------------------------------------------------
 *
 * The NyARToolkit is Java edition ARToolKit class library.
 * Copyright (C)2008-2012 Ryo Iizuka
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as publishe
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * For further information please contact.
 *	http://nyatla.jp/nyatoolkit/
 *	<airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
 * 
 */
using System;
using System.Diagnostics;
namespace jp.nyatla.nyartoolkit.cs.core
{

    /**
     * このクラスは、指定形式のバッファを持つインスタンスを生成します。
     * <p>対応しているバッファ形式は以下の通りです。
     * <ul>
     * <li>{@link NyARBufferType#INT1D}
     * <li>{@link NyARBufferType#INT1D_X8R8G8B8_32}
     * <ul>
     * </p>
     *
     */
    public class NyARRaster : NyARRaster_BasicClass
    {
        /** バッファオブジェクトの変数*/
        protected Object _buf;
        /** バッファオブジェクトがアタッチされていればtrue*/
        protected bool _is_attached_buffer;
        /**
         * コンストラクタです。
         * 画像のサイズパラメータとバッファ形式を指定して、インスタンスを生成します。
         * @param i_width
         * ラスタのサイズ
         * @param i_height
         * ラスタのサイズ
         * @param i_buffer_type
         * ラスタの画素形式。
         * {@link NyARBufferType}に定義された定数値を指定してください。
         * 指定できる値は、クラスの説明を見てください。
         * @throws NyARRuntimeException
         */
        public NyARRaster(int i_width, int i_height, int i_buffer_type):this(i_width, i_height, i_buffer_type, true)
        {
            
            return;
        }
        /**
         * コンストラクタです。
         * 画像のサイズパラメータとバッファ形式を指定して、インスタンスを生成します。
         * @param i_width
         * ラスタのサイズ
         * @param i_height
         * ラスタのサイズ
         * @param i_buffer_type
         * ラスタの画素形式。
         * {@link NyARBufferType}に定義された定数値を指定してください。
         * 指定できる値は、クラスの説明を見てください。
         * @param i_is_alloc
         * バッファを外部参照にするかのフラグ値。
         * trueなら内部バッファ、falseなら外部バッファを使用します。
         * falseの場合、初期のバッファはnullになります。インスタンスを生成したのちに、{@link #wrapBuffer}を使って割り当ててください。
         * @throws NyARRuntimeException
         */
        public NyARRaster(int i_width, int i_height, int i_buffer_type, bool i_is_alloc)
            : base(i_width, i_height, i_buffer_type)
        {
            if (!initInstance(this._size, i_buffer_type, i_is_alloc))
            {
                throw new NyARRuntimeException();
            }
            return;
        }
        /**
         * このクラスの初期化シーケンスです。コンストラクタから呼び出します。
         * @param i_size
         * ラスタサイズ
         * @param i_buf_type
         * バッファ形式
         * @param i_is_alloc
         * バッファ参照方法値
         * @return
         * 初期化に成功するとtrueを返します。
         */
        private bool initInstance(NyARIntSize i_size, int i_buf_type, bool i_is_alloc)
        {
            switch (i_buf_type)
            {
                case NyARBufferType.INT1D:
                case NyARBufferType.INT1D_X8R8G8B8_32:
                    this._buf = i_is_alloc ? new int[i_size.w * i_size.h] : null;
                    break;

                default:
                    return false;
            }
            this._is_attached_buffer = i_is_alloc;
            return true;
        }
        /**
         * この関数は、ラスタのバッファへの参照値を返します。
         * バッファの形式は、コンストラクタに指定した形式と同じです。
         */
        override public Object getBuffer()
        {
            return this._buf;
        }
        /**
         * インスタンスがバッファを所有するかを返します。
         * コンストラクタでi_is_allocをfalseにしてラスタを作成した場合、
         * バッファにアクセスするまえに、バッファの有無をこの関数でチェックしてください。
         */
        override public bool hasBuffer()
        {
            return this._buf != null;
        }
        /**
         * この関数は、ラスタに外部参照バッファをセットします。
         * 外部参照バッファを持つインスタンスでのみ使用できます。内部参照バッファを持つインスタンスでは使用できません。
         */
        override public void wrapBuffer(Object i_ref_buf)
        {
            Debug.Assert(!this._is_attached_buffer);//バッファがアタッチされていたら機能しない。
            this._buf = i_ref_buf;
        }
        override public Object createInterface(Type iIid)
        {
            // TODO Auto-generated method stub
            return null;
        }

    }
}
